isConditionSatisfied
isConditionSatisfied
isConditionSatisfied(metric: ConditionalMetric , parameters?: Parameter[] , lhsColValue?: "null" | string | number , rhsColValue?: "null" | string | number ) : boolean
Evaluates whether the condition defined by the metric is satisfied.
Function Parameters
metric:::
- metric: ConditionalMetric
The conditional formatting metric info
parameters::: Optional
- parameters: Parameter[]
An array of parameters that may include the parameter needed for ParameterBased comparison.
lhsColValue::: Optional
- lhsColValue: | string | number
The value of the left-hand side column, used in ColumnBased and some ValueBased comparisons.
rhsColValue::: Optional
- rhsColValue: | string | number
The value of the right-hand side column, used in ColumnBased comparisons.
Returns
boolean
Defined in : link:https://github.com/thoughtspot/ts-chart-sdk/blob/f477c20/src/utils/conditional-formatting/conditional-formatting.ts#L115
--